/*-
 * Copyright (c) 2006, 2007 FTS Team
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 4. Neither the name of the FTS Team nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *      SnippetCollector.hpp
 *
 * $FTS$
 */
#ifndef _SNIPPET_COLLECTOR_HPP__
#define _SNIPPET_COLLECTOR_HPP__ 1

/**
  @file SnippetCollector.hpp
  @brief Snippet collector
*/

#include <FTSTypes.h>
#include <STLString.hpp>
//#include <OutputDataCollector.hpp>
//#include <RankedDocument.hpp>
//#include <STLVector.hpp>
//#include <TermStatistic.hpp>

namespace FTSS // FullTextSearchSystem
{
// FWD
class DocumentStorage;
class IRConfig;
class OutputDataCollector;
class Passage;
class RankedDocument;
class TermStatistic;
class WordEntryPos;

/**
  @class SnippetCollector SnippetCollector.hpp <SnippetCollector.hpp>
  @brief Search result collector interface
*/
class SnippetCollector
{
public:
	/**
	  @brief Constructor
	  @param pICollector - Output data collector
	  @param pIDocumentStorage - Document data storage
	  @param pIIRConfig - global configuration
	*/
	SnippetCollector(OutputDataCollector  * pICollector,
	                 DocumentStorage      * pIDocumentStorage,
	                 IRConfig             * pIIRConfig);

	/**
	  @brief Start output of document
	  @param dExecTime - execution time
	  @param iDocumentsCount - number of documents
	  @param aTerms - statistic of query
	  @param iTermsCount - number of terms in query
	  @return 0 if success, -1 if any error occured
	*/
	INT_32 StartOutput(W_FLOAT dExecTime, const INT_32 & iDocumentsCount, const TermStatistic * aTerms, const INT_32 & iTermsCount);

	/**
	  @brief Add document to result set
	  @param oRankedDocument - document with snippets
	  @return 0 if success, -1 if any error occured
	*/
	INT_32 AddDocument(const RankedDocument & oRankedDocument);

	/**
	  @brief End of output
	  @return 0 if success, -1 if any error occured
	*/
	INT_32 EndOutput();

	/**
	  @brief A destructor
	*/
	~SnippetCollector() throw();
private:
	/** Output data collector                */
	OutputDataCollector   * pCollector;
	/** Document data storage                */
	DocumentStorage       * pDocumentStorage;
	/** Configuration                        */
	IRConfig              * pIRConfig;
	/** Maximum documents in output          */
	UINT_32                 iMaxDocuments;
	/** Maximum length of snippet            */
	UINT_32                 iMaxSnippetLength;
	/** Opener tag to highlight found word   */
	STLW::string            sHLStartTag;
	/** Close tag to highlight found word    */
	STLW::string            sHLEndTag;

	/** Documents in output                  */
	UINT_32                 iRegisteredDocuments;

};

} // namespace FTSS
#endif // _SNIPPET_COLLECTOR_HPP__
// End.
